get /cloud/aws/vpcs
List AWS VPCs (getAwsVpcs)
Lists the AWS VPCs.
Consumes
This API call consumes the following media types via the Content-Type request header:
- application/json
Query parameters
region (required)
Query Parameter — AWS region
credentialsName (required)
Query Parameter — Cloud credentials name
Return type
array[Vpc]
|
cidrBlock (optional) |
String CIDR block |
||||
|
default (optional) |
Boolean Indicates whether the VPC is the default VPC |
||||
|
id (optional) |
String VPC ID |
||||
|
state (optional) |
AvailabilityState Availability state - pending or available |
||||
|
tags (optional) |
array[Tag] VPC tags
|
Example data
Content-Type: application/json
[
{
"cidrBlock": "10.10.1.0/24",
"default": true,
"id": "vpc-123456",
"state": "Pending",
"tags": [
{
"key": "Owner",
"value": "Velostrata"
}
]
}
]
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
- application/json
Responses
200
OK
Default
Error ErrorInfo
|
errorCode (optional) |
String |
|
url(optional) |
String |
|
message (optional) |
String |